多通貨クレジットカード決済(DCC) API一覧
HTTP仕様(.idPass)
HTTP仕様(.json)
Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: text/plain;charset=windows-31j |
|
Status Code |
200:常に200を返却 |
Request header |
Content-Type: application/json;charset=UTF-8 |
|
---|---|---|
Method |
POST |
|
Response header |
Content-Type: application/json;charset=UTF-8 |
|
Status Code |
|
・E90010001
・E92000001
・E92000002
・E91099996
・E91099997
EntryTranDcc 取引登録
これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
リクエスト
ShopID | shopID |
必須
半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass |
必須
半角英数64桁
ショップパスワード
|
||
OrderID | orderID |
必須
半角英数記号27桁
オーダーID
|
||
ItemCode | itemCode |
半角数字7桁
商品コードデフォルトは「0000990」になります。 |
||
DccCurrency | dccCurrency |
必須
半角英字3桁
支払通貨コード設定できるコードについてはこちら |
||
Ftn | ftn |
半角数字12桁
FX追跡番号
最大12桁の数字を設定します。
|
||
Amount | amount |
必須
半角数字7桁
利用金額利用金額(日本円)を設定します。 |
||
Tax | tax |
半角数字7桁
税送料税送料(日本円)を指定した場合は、利用金額+税送料を支払通貨で換算した値が支払金額となります。 |
/payment/EntryTranDcc.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"orderID": "ORDER0000001",
"dccCurrency": "USD",
"amount": "1000"
}
/payment/EntryTranDcc.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&DccCurrency=USD&Amount=1000
レスポンス
正常
OrderID | orderID |
半角英数記号27桁
オーダーID
|
||
---|---|---|---|---|
AccessID | accessID |
半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass |
半角英数32桁 固定
取引パスワード
|
||
DccCurrency | dccCurrency |
半角英字3桁
支払通貨コード |
||
DccAmount | dccAmount |
半角数字記号12桁
支払通貨決済額
支払通貨換算後の金額を返却します。
|
||
DccRate | dccRate |
半角数字記号11桁
為替レート支払通貨換算に適用した為替レートを返却します。(整数部6桁、小数部5桁) |
||
Ftn | ftn |
半角数字12桁
FX追跡番号(FTN)入力パラメータの値を返却します。省略した場合は、支払通貨換算に適用した為替レートに紐付くFTNを返却します。 |
{
"orderID": "ORDER0000001",
"accessID": "a6a6b0061347e90cdef806b39bd28705",
"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
"dccCurrency": "USD",
"dccAmount": "1.11",
"dccRate": "0.01111",
"ftn": "11111111"
}
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&DccCurrency=USD&DccAmount=1.11&DccRate=0.01111&Ftn=11111111
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
ExecTranDcc 決済実行
会員登録済みのカードで、カード会社と通信を行い、決済を実施した結果を返します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
||
ClientFieldFlag | clientFieldFlag | 半角数字1桁
加盟店自由項目返却フラグ
0:返却しない デフォルト |
||
SiteID | siteID | 必須 半角英数13桁
サイトID |
||
SitePass | sitePass | 必須 半角英数64桁
サイトパスワード |
||
MemberID | memberID | 必須 半角英数記号60桁
会員ID |
||
SeqMode | seqMode | 半角数字1桁
カード登録連番モード
0: 論理モード(デフォルト) |
||
CardSeq | cardSeq | 半角数字4桁
カード登録連番決済に使用するカード登録連番を設定します。 |
||
CardPass | cardPass | 半角英数20桁
カードパスワード カード登録時に設定したパスワードを設定します。 |
/payment/ExecTranDcc.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "8867bfeec7b7fc35f78320d01c9a6c10",
"accessPass": "c07822acefba90d95417ae37beb198de",
"orderID": "TEST-20190628-133057",
"siteID": "tsite99887814",
"sitePass": "PASSWORD",
"memberID": "Member00"
"seqMode": "0"
"cardSeq": "0001"
"cardPass": "PassWord"
"clientField1": "項目1"
"clientField2": "項目2"
"clientField3": "項目3"
"clientFieldFlag": "1"
}
/payment/ExecTranDcc.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=8867bfeec7b7fc35f78320d01c9a6c10&AccessPass=c07822acefba90d95417ae37beb198de&OrderID=TEST-20190628-133057&SiteID=tsite99887814&SitePass=PASSWORD&MemberID=Member00&SeqMode=0&CardSeq=0001&CardPass=PassWord&ClientField1=項目1&ClientField2=項目2&ClientField3=項目3&ClientFieldFlag=1
レスポンス
正常
ACS | aCS | 半角数字1桁
ACS呼出判定0:ACS呼出不要 |
||
---|---|---|---|---|
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
Method | method | 半角数字1桁
支払方法1:一括 |
||
DccTranID | dccTranID | 半角英数10桁
DCCトランザクションID当サービスが発行している取引の処理番号を返却します。 |
||
TranDate | tranDate | 半角数字14桁 固定
決済日付yyyyMMddHHmmss形式 |
||
CheckString | checkString | 半角英数32桁
MD5ハッシュ出力パラメータのオーダーID、支払方法、DCCトランザクションID、ショップパスワードのハッシュ値を返却します。 |
||
DccCurrency | dccCurrency | 半角英字3桁
支払通貨コード |
||
DccAmount | dccAmount | 半角数字記号12桁
支払通貨決済額 【取引登録】で算出した値を返却します。 |
||
DccRate | dccRate | 半角数字記号11桁
為替レート 【取引登録】で使用した為替レートの値を返却します。 |
||
Ftn | ftn | 半角数字12桁
FX追跡番号【取引登録】で使用した為替レートに紐付くFTN を返却します。 |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
{
"aCS": "0",
"orderID": "TEST-20190628-115812",
"method": "1",
"dccTranID": "1917900745",
"tranDate": "20190628120831",
"checkString": "6bff1f1547394b9fc37407dfc0d49c31",
"dccCurrency": "USD",
"dccAmount": "0.99",
"dccRate": "0.00985",
"ftn": "16755674",
"clientField1": "自由欄1",
"clientField2": "自由欄2",
"clientField3": "自由欄3"
}
ACS=0&OrderID=TEST-20190628-115812&Method=1&DccTranID=1917900745&TranDate=20190628120831&CheckString=6bff1f1547394b9fc37407dfc0d49c31&DccCurrency=USD&DccAmount=0.99&DccRate=0.00985&Ftn=16755674&ClientField1=自由欄1&ClientField2=自由欄2&ClientField3=自由欄3
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
CancelTranDcc 決済取消
決済が完了した取引に対して決済内容の取り消しを行います。
指定された取引情報および為替レートを使用して、取り消しを実施します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
DccFlag | dccFlag | 半角数字1桁
DCCフラグ
0:売上時の為替レート(デフォルト) |
/payment/CancelTranDcc.json
{
"shopID": "tshop11223344",
"shopPass": "PASSWORD",
"accessID": "4cfffa3f3ef6e90692dbc204e09b351b",
"accessPass": "c07822acefba90d95417ae37beb198de",
"orderID": "TEST-20190628-131929",
"dccFlag": "0"
}
/payment/CancelTranDcc.idPass
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=4cfffa3f3ef6e90692dbc204e09b351b&AccessPass=c07822acefba90d95417ae37beb198de&OrderID=TEST-20190628-131929&DccFlag=0
レスポンス
正常
AccessID | accessID | 半角英数32桁 固定
取引ID
|
||
---|---|---|---|---|
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
Status | status |
現状態 取消成功時は以下を返却します。 |
||
DccAmount | dccAmount | 半角数字記号12桁
支払通貨決済額(取消後)支払通貨換算した取消後の金額を返却します。(整数部10桁、小数部2桁) |
||
DccRate | dccRate | 半角数字記号11桁
為替レート【取消】呼出時に設定した為替レートの値を返却します。(整数部6桁、小数部5桁) |
||
Ftn | ftn | 半角数字12桁
FX追跡番号(FTN)支払通貨換算に適用した為替レートに紐付くFTNを返却します。 |
{
"accessID": "b4e08d3cd75df2755d32b783e40bf13b",
"orderID": "TEST-20190628-115812",
"status": "VOID",
"dccAmount": "0",
"dccRate": "0.00985",
"ftn": "16755674"
}
AccessID=b4e08d3cd75df2755d32b783e40bf13b&OrderID=TEST-20190628-115812&Status=VOID&DccAmount=0&DccRate=0.00985&Ftn=16755674
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
ChangeTranDcc 金額変更
決済が完了した取引に対して決済金額の変更を行います。 指定された取引情報を使用してカード会社と通信を行い、金額変更を実施します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
AccessID | accessID | 必須 半角英数32桁 固定
取引ID
|
||
AccessPass | accessPass | 必須 半角英数32桁 固定
取引パスワード
|
||
OrderID | orderID | 必須 半角英数記号27桁
オーダーID
|
||
ChangeAmount | changeAmount | 必須 半角数字7桁
利用金額(金額変更後)金額変更後の利用金額(日本円)を設定します。0円を設定した場合はエラーとなります。 |
||
ChangeTax | changeTax | 半角数字7桁
税送料(金額変更後)金額変更後の税送料(日本円)を設定します。利用金額(金額変更後)+税送料(金額変更後)を支払通貨で換算した値が支払金額となります。利用金額(金額変更後) +税送料(金額変更後)で1円以上9,999,999 円以下である必要があります。 |
||
TdFlag | tdFlag | 半角数字1桁
3DS利用フラグ
0:行わない(デフォルト) |
||
SecurityCode | securityCode | 半角数字3桁
セキュリティコードカードに記載されている3桁もしくは4桁の数字 |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
||
ClientFieldFlag | clientFieldFlag | 半角数字1桁
加盟店自由項目返却フラグ |
/payment/ChangeTranDcc.json
{
"shopID": "tshop99887902",
"shopPass": "PASSWORD",
"accessID": "4cfffa3f3ef6e90692dbc204e09b351b",
"accessPass": "c07822acefba90d95417ae37beb198de",
"orderID": "TEST-20190628-133057",
"changeAmount": "200",
"changeTax": "20",
"tdFlag": "1",
"securityCode": "123",
"clientField1": "項目1",
"clientField2": "項目2",
"clientField3": "項目3",
"clientFieldFlag": "1"
}
/payment/ChangeTranDcc.idPass
ShopID=tshop99887902&ShopPass=PASSWORD&AccessID=4cfffa3f3ef6e90692dbc204e09b351b&AccessPass=c07822acefba90d95417ae37beb198de&OrderID=TEST-20190628-133057&ChangeAmount=200&ChangeTax=20&TdFlag=1&SecurityCode=123&ClientField1=項目1&ClientField2=項目2&ClientField3=項目3&ClientFieldFlag=1
レスポンス
正常
ACS | aCS | 半角数字1桁
ACS呼出判定0:ACS 呼出不要 |
||
---|---|---|---|---|
OrderID | orderID | 半角英数記号27桁
オーダーID
|
||
Method | method | 半角数字1桁
支払方法1:一括 |
||
DccCurrency | dccCurrency | 半角英字3桁
支払通貨コード |
||
DccAmount | dccAmount | 半角数字記号12桁
支払通貨決済額(金額変更後) 支払通貨換算後の金額を返却します。 |
||
DccRate | dccRate | 半角数字記号11桁
為替レート(金額変更後) 支払通貨換算に適用した為替レートを返却します。(整数部6桁、小数部5桁) |
||
Ftn | ftn | 半角数字12桁
FX追跡番号(FTN)支払通貨換算に適用した為替レートに紐付くFTNを返却します。 |
||
ClientField1 | clientField1 | 全半角100バイト
加盟店自由項目1
|
||
ClientField2 | clientField2 | 全半角100バイト
加盟店自由項目2
|
||
ClientField3 | clientField3 | 全半角100バイト
加盟店自由項目3
|
{
"aCS": "0",
"orderID": "TEST-20190628-115812",
"method": "1",
"dccCurrency": "USD",
"dccAmount": "0.99",
"dccRate": "0.00985",
"ftn": "16755674",
"clientField1": "自由欄1",
"clientField2": "自由欄2",
"clientField3": "自由欄3",
}
ACS=0&OrderID=TEST-20190628-115812&Method=1&DccCurrency=USD&DccAmount=0.99&DccRate=0.00985&Ftn=16755674&ClientField1=自由欄1&ClientField2=自由欄2&ClientField3=自由欄3
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
SearchRateAllDcc 全レート照会
支払対象となる全通貨における為替レート(最新分)を一括で取得します。
レスポンス
{
"rateData": ""
}
RateData=
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
※1:以下のXMLフォーマットをBASE64エンコーディングした値を返却します。
[XMLフォーマット]
ratesInfo |
レート情報レート情報親属性 |
---|---|
rate |
レート取扱い通貨全てを、通貨ごとの複数属性で返却します。 |
dccCurrency |
半角英字3桁
支払通貨コード支払通貨コード(英字)を返却します。 |
dccRate |
半角数字記号11桁
為替レート最新の為替レート(整数部6桁、小数部5桁)を返却します。 |
ftn |
半角数字12桁
FX追跡番号(FTN)最大12桁の数字を返却します。 |
updated |
半角数字13桁
更新日時当サービスが為替レートの取込みを実施した日時をエポック (1970/1/1 00:00:00+0000 )からのミリ秒数で返却します。 |
[XML 例(エンコード前)]
<ratesInfo>
<rate>
<dccCurrency>USD</dccCurrency>
<dccRate>0.00834</dccRate>
<ftn>123456789012</ftn>
<updated>1457576007345</updated>
</rate>
<rate>
<dccCurrency>EUR</dccCurrency>
<dccRate>0.00747</dccRate>
<ftn>123456789013</ftn>
<updated>1457576007345</updated>
</rate>
<rate>
<dccCurrency>BRL</dccCurrency>
<dccRate>0.02897</dccRate>
<ftn>123456789014</ftn>
<updated>1457576007345</updated>
</rate>
・
・
</ratesInfo>
SearchRateDcc ショップ別レート照会
購入対象商品の金額について、加盟店通貨から支払通貨に換算した金額(為替レート換算および為替手数料を含む金額)を取得します。
リクエスト
ShopID | shopID | 必須 半角英数13桁
ショップID
|
||
---|---|---|---|---|
ShopPass | shopPass | 必須 半角英数64桁
ショップパスワード
|
||
Amount | amount | 必須
利用金額税送料を含む金額(加盟店通貨)を指定してください。整数部桁数、小数点以下桁数は、加盟店通貨により異なります。 |
||
DccCurrency | dccCurrency | 半角英字3桁
支払通貨コード設定できるコードについてはこちら |
||
Ftn | ftn | 半角数字12桁
FX追跡番号(FTN)最大1桁の数字を設定します。 |
※DccCurrencyかFTNのいずれか一方のみを設定してください。
DccCurrencyを設定した場合は、送信時点の日付における為替レートが要求されます。
/payment/SearchRateDcc.json
{
"shopID": "tshop99887902",
"shopPass": "PASSWORD",
"amount": "100",
"dccCurrency": "USD"
}
/payment/SearchRateDcc.idPass
ShopID=tshop99887902&ShopPass=PASSWORD&Amount=100&DccCurrency=USD
レスポンス
正常
DccCurrency | dccCurrency | 半角英字3桁
支払通貨コード |
||
---|---|---|---|---|
DccAmount | dccAmount |
支払通貨決済額【レート照会】で換算された値を返却します。整数部桁数、小数点以下桁数は、支払通貨により異なります。 |
||
DccRate | dccRate | 半角数字記号11桁
為替レート支払通貨が指定された場合は最新の為替レート、FX追跡番号(FTN)が指定された場合はFTNに紐付く為替レートを返却します。(整数部6桁、小数部5桁) |
||
Ftn | ftn | 半角数字12桁
FX追跡番号入力パラメータの値を返却します。入力パラメータが省略された場合は、為替レートに紐付くFTNを返却します。 |
||
Updated | updated | 半角数字13桁
更新日時当サービスが為替レートの取込みを実施した日時をエポック (1970/1/1 00:00:00 +0000 からのミリ秒数で返却します。 |
{
"dccCurrency": "USD",
"dccAmount": "0.99",
"dccRate": "0.00985",
"ftn": "16755674",
"updated": "1558317608194"
}
DccCurrency=USD&DccAmount=0.99&DccRate=0.00985&Ftn=16755674&Updated=1558317608194
[
{
"errCode":"E01",
"errInfo":"E01040001"
}
]
ErrCode=E01&ErrInfo=E01040001
SearchTradeMulti 取引状態参照
対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。
レスポンス
正常
Status |
現状態 UNPROCESSED:未決済 |
|
---|---|---|
ProcessDate | 半角数字14桁 固定
処理日時yyyyMMddHHmmss書式 |
|
JobCd |
処理区分 CAPTURE:即時売上 |
|
AccessID | 半角英数32桁 固定
取引ID
|
|
AccessPass | 半角英数32桁 固定
取引パスワード
|
|
ItemCode | 半角英数7桁
商品コード
|
|
Amount | 半角数字7桁
利用金額
|
|
Tax | 半角数字7桁
税送料
|
|
Currency | 半角英数3桁
通貨コード
|
|
SiteID | 半角英数13桁
サイトID
|
|
MemberID | 半角英数60桁
会員ID
|
|
CardNo | 半角数字16桁
カード番号下4桁以外は伏字となります。 |
|
Expire | 半角数字4桁
有効期限
|
|
Method | 半角数字1桁
支払方法1:一括 |
|
ClientField1 | 全半角100バイト
加盟店自由項目1
|
|
ClientField2 | 全半角100バイト
加盟店自由項目2
|
|
ClientField3 | 全半角100バイト
加盟店自由項目3
|
|
PayType | 半角数字2桁
決済方法41:多通貨クレジットカード決済(DCC) |
|
TotalCancelAmount | 半角数字7桁
減額金額の累積
|
|
TotalCancelTax | 半角数字7桁
減額税送料の累積
|
|
TotalIncreaseAmount | 半角数字7桁
増額金額の累積
|
|
TotalIncreaseTax | 半角数字7桁
増額税送料の累積
|
|
DccAmount | 半角数字12桁
支払通貨決済額為替レート変換後の金額(為替手数料、税送料込み)を返却します。 |
|
DccFtn | 半角数字12桁
FX追跡番号(FTN)
|
Status=CAPTURE&ProcessDate=20190213200436&JobCd=CAPTURE&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&ItemCode=&Amount=10000&Tax=10000&Currency=&SiteID=&MemberID=&CardNo=&Expire=&Method=&ClientField1=&ClientField2=&ClientField3=&PayType=41&TotalCancelAmount=500&TotalCancelTax=50&TotalIncreaseAmount=&TotalIncreaseTax=&DccAmount=&DccFtn=
ErrCode=E01&ErrInfo=E01040001